|
PriceBook
An object that represents either a produce price book or an expense price books.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the PriceBook object. When adding a new PriceBook the value must be 0. |
|
Name |
string (100) |
The name of the price/expense book. |
|
Description |
string (100) |
The price/expense book's description field text. |
|
CurrencyIsoCode |
string (100) |
Three letter currency code. |
|
IsActive |
boolean |
Flag indicating the price/expense book is active in BlueCamroo. |
|
PricePercentage |
double |
In a price book, the value for the Percentage of Default Price field. Optional. |
|
Type |
string (100) |
Indicates whether it's a pricebook or expense book. Values are: product or expense. |
List
Description
Returns a list of expense price books or price books.
URL
https://{company}.bluecamroo.com/api/pricebook/list?isActive={isActive}&type={type}
HTTP Method
GET
Parameters
None
Data Return
Returns a list of book. The list can be a list of price books or expense price books as well as active or not active. The list is returned in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Description
Returns a pricebook or expense pricebook's details.
URL
https://{company}.bluecamroo.com/api/pricebook/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the pricebook object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds an expense or pricebook.
URL
https://{company}.bluecamroo.com/api/pricebook/add
HTTP Method
POST
Parameters
A pricebook object
Data Return
Returns the pricebook object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates price or expense book.
URL
https://{company}.bluecamroo.com/api/pricebook/update
HTTP Method
PUT
Parameters
A pricebook object
Data Return
Returns the pricebook object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified pricebook or expense book.
URL
https://{company}.bluecamroo.com/api/pricebook/pricebook/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|